home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_emacs.idb / usr / freeware / share / emacs / 19.34 / lisp / perl-mode.el.z / perl-mode.el
Encoding:
Text File  |  1998-10-28  |  28.7 KB  |  727 lines
  1. ;;; perl-mode.el --- Perl code editing commands for GNU Emacs
  2.  
  3. ;; Copyright (C) 1990, 1994  Free Software Foundation, Inc.
  4.  
  5. ;; Author: William F. Mann
  6. ;; Maintainer: FSF
  7. ;; Adapted-By: ESR
  8. ;; Keywords: languages
  9.  
  10. ;; Adapted from C code editing commands 'c-mode.el', Copyright 1987 by the
  11. ;; Free Software Foundation, under terms of its General Public License.
  12.  
  13. ;; This file is part of GNU Emacs.
  14.  
  15. ;; GNU Emacs is free software; you can redistribute it and/or modify
  16. ;; it under the terms of the GNU General Public License as published by
  17. ;; the Free Software Foundation; either version 2, or (at your option)
  18. ;; any later version.
  19.  
  20. ;; GNU Emacs is distributed in the hope that it will be useful,
  21. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  22. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23. ;; GNU General Public License for more details.
  24.  
  25. ;; You should have received a copy of the GNU General Public License
  26. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  27. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  28. ;; Boston, MA 02111-1307, USA.
  29.  
  30. ;;; Commentary:
  31.  
  32. ;; To enter perl-mode automatically, add (autoload 'perl-mode "perl-mode")
  33. ;; to your .emacs file and change the first line of your perl script to:
  34. ;; #!/usr/bin/perl --     # -*-Perl-*-
  35. ;; With arguments to perl:
  36. ;; #!/usr/bin/perl -P-     # -*-Perl-*-
  37. ;; To handle files included with do 'filename.pl';, add something like
  38. ;; (setq auto-mode-alist (append (list (cons "\\.pl\\'" 'perl-mode))
  39. ;;                               auto-mode-alist))
  40. ;; to your .emacs file; otherwise the .pl suffix defaults to prolog-mode.
  41.  
  42. ;; This code is based on the 18.53 version c-mode.el, with extensive
  43. ;; rewriting.  Most of the features of c-mode survived intact.
  44.  
  45. ;; I added a new feature which adds functionality to TAB; it is controlled
  46. ;; by the variable perl-tab-to-comment.  With it enabled, TAB does the
  47. ;; first thing it can from the following list:  change the indentation;
  48. ;; move past leading white space; delete an empty comment; reindent a
  49. ;; comment; move to end of line; create an empty comment; tell you that
  50. ;; the line ends in a quoted string, or has a # which should be a \#.
  51.  
  52. ;; If your machine is slow, you may want to remove some of the bindings
  53. ;; to electric-perl-terminator.  I changed the indenting defaults to be
  54. ;; what Larry Wall uses in perl/lib, but left in all the options.
  55.  
  56. ;; I also tuned a few things:  comments and labels starting in column
  57. ;; zero are left there by indent-perl-exp; perl-beginning-of-function
  58. ;; goes back to the first open brace/paren in column zero, the open brace
  59. ;; in 'sub ... {', or the equal sign in 'format ... ='; indent-perl-exp
  60. ;; (meta-^q) indents from the current line through the close of the next
  61. ;; brace/paren, so you don't need to start exactly at a brace or paren.
  62.  
  63. ;; It may be good style to put a set of redundant braces around your
  64. ;; main program.  This will let you reindent it with meta-^q.
  65.  
  66. ;; Known problems (these are all caused by limitations in the Emacs Lisp
  67. ;; parsing routine (parse-partial-sexp), which was not designed for such
  68. ;; a rich language; writing a more suitable parser would be a big job):
  69. ;; 1)  Regular expression delimiters do not act as quotes, so special
  70. ;;       characters such as `'"#:;[](){} may need to be backslashed
  71. ;;       in regular expressions and in both parts of s/// and tr///.
  72. ;; 2)  The globbing syntax <pattern> is not recognized, so special
  73. ;;       characters in the pattern string must be backslashed.
  74. ;; 3)  The q, qq, and << quoting operators are not recognized; see below.
  75. ;; 4)  \ (backslash) always quotes the next character, so '\' is
  76. ;;       treated as the start of a string.  Use "\\" as a work-around.
  77. ;; 5)  To make variables such a $' and $#array work, perl-mode treats
  78. ;;       $ just like backslash, so '$' is the same as problem 5.
  79. ;; 6)  Unfortunately, treating $ like \ makes ${var} be treated as an
  80. ;;       unmatched }.  See below.
  81. ;; 7)  When ' (quote) is used as a package name separator, perl-mode
  82. ;;       doesn't understand, and thinks it is seeing a quoted string.
  83.  
  84. ;; Here are some ugly tricks to bypass some of these problems:  the perl
  85. ;; expression /`/ (that's a back-tick) usually evaluates harmlessly,
  86. ;; but will trick perl-mode into starting a quoted string, which
  87. ;; can be ended with another /`/.  Assuming you have no embedded
  88. ;; back-ticks, this can used to help solve problem 3:
  89. ;;
  90. ;;     /`/; $ugly = q?"'$?; /`/;
  91. ;;
  92. ;; To solve problem 6, add a /{/; before each use of ${var}:
  93. ;;     /{/; while (<${glob_me}>) ...
  94. ;;
  95. ;; Problem 7 is even worse, but this 'fix' does work :-(
  96. ;;     $DB'stop#'
  97. ;;         [$DB'line#'
  98. ;;          ] =~ s/;9$//;
  99.  
  100. ;;; Code:
  101.  
  102. (defvar perl-mode-abbrev-table nil
  103.   "Abbrev table in use in perl-mode buffers.")
  104. (define-abbrev-table 'perl-mode-abbrev-table ())
  105.  
  106. (defvar perl-mode-map ()
  107.   "Keymap used in Perl mode.")
  108. (if perl-mode-map
  109.     ()
  110.   (setq perl-mode-map (make-sparse-keymap))
  111.   (define-key perl-mode-map "{" 'electric-perl-terminator)
  112.   (define-key perl-mode-map "}" 'electric-perl-terminator)
  113.   (define-key perl-mode-map ";" 'electric-perl-terminator)
  114.   (define-key perl-mode-map ":" 'electric-perl-terminator)
  115.   (define-key perl-mode-map "\e\C-a" 'perl-beginning-of-function)
  116.   (define-key perl-mode-map "\e\C-e" 'perl-end-of-function)
  117.   (define-key perl-mode-map "\e\C-h" 'mark-perl-function)
  118.   (define-key perl-mode-map "\e\C-q" 'indent-perl-exp)
  119.   (define-key perl-mode-map "\177" 'backward-delete-char-untabify)
  120.   (define-key perl-mode-map "\t" 'perl-indent-command))
  121.  
  122. (autoload 'c-macro-expand "cmacexp"
  123.   "Display the result of expanding all C macros occurring in the region.
  124. The expansion is entirely correct because it uses the C preprocessor."
  125.   t)
  126.  
  127. (defvar perl-mode-syntax-table nil
  128.   "Syntax table in use in perl-mode buffers.")
  129.  
  130. (if perl-mode-syntax-table
  131.     ()
  132.   (setq perl-mode-syntax-table (make-syntax-table (standard-syntax-table)))
  133.   (modify-syntax-entry ?\n ">" perl-mode-syntax-table)
  134.   (modify-syntax-entry ?# "<" perl-mode-syntax-table)
  135.   (modify-syntax-entry ?$ "/" perl-mode-syntax-table)
  136.   (modify-syntax-entry ?% "." perl-mode-syntax-table)
  137.   (modify-syntax-entry ?& "." perl-mode-syntax-table)
  138.   (modify-syntax-entry ?\' "\"" perl-mode-syntax-table)
  139.   (modify-syntax-entry ?* "." perl-mode-syntax-table)
  140.   (modify-syntax-entry ?+ "." perl-mode-syntax-table)
  141.   (modify-syntax-entry ?- "." perl-mode-syntax-table)
  142.   (modify-syntax-entry ?/ "." perl-mode-syntax-table)
  143.   (modify-syntax-entry ?< "." perl-mode-syntax-table)
  144.   (modify-syntax-entry ?= "." perl-mode-syntax-table)
  145.   (modify-syntax-entry ?> "." perl-mode-syntax-table)
  146.   (modify-syntax-entry ?\\ "\\" perl-mode-syntax-table)
  147.   (modify-syntax-entry ?` "\"" perl-mode-syntax-table)
  148.   (modify-syntax-entry ?| "." perl-mode-syntax-table)
  149. )
  150.  
  151. (defvar perl-imenu-generic-expression
  152.   '(
  153.     ;; Functions
  154.     (nil "^sub\\s-+\\([-A-Za-z0-9+_:]+\\)\\(\\s-\\|\n\\)*{" 1 )
  155.     ;;Variables
  156.     ("Variables" "^\\([$@%][-A-Za-z0-9+_:]+\\)\\s-*=" 1 )
  157.     ("Packages" "^package\\s-+\\([-A-Za-z0-9+_:]+\\);" 1 )
  158.     )
  159.   "Imenu generic expression for Perl mode.  See `imenu-generic-expression'.")
  160.  
  161. ;; Regexps updated with help from Tom Tromey <tromey@cambric.colorado.edu> and
  162. ;; Jim Campbell <jec@murzim.ca.boeing.com>.
  163.  
  164. (defconst perl-font-lock-keywords-1
  165.   '(;; What is this for?
  166.     ;;("\\(--- .* ---\\|=== .* ===\\)" . font-lock-string-face)
  167.     ;;
  168.     ;; Fontify preprocessor statements as we do in `c-font-lock-keywords'.
  169.     ;; Ilya Zakharevich <ilya@math.ohio-state.edu> thinks this is a bad idea.
  170.     ("^#[ \t]*include[ \t]+\\(<[^>\"\n]+>\\)" 1 font-lock-string-face)
  171.     ("^#[ \t]*define[ \t]+\\(\\sw+\\)(" 1 font-lock-function-name-face)
  172.     ("^#[ \t]*if\\>"
  173.      ("\\<\\(defined\\)\\>[ \t]*(?\\(\\sw+\\)?" nil nil
  174.       (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t)))
  175.     ("^#[ \t]*\\(\\sw+\\)\\>[ \t]*\\(\\sw+\\)?"
  176.      (1 font-lock-reference-face) (2 font-lock-variable-name-face nil t))
  177.     ;;
  178.     ;; Fontify function and package names in declarations.
  179.     ("\\<\\(package\\|sub\\)\\>[ \t]*\\(\\sw+\\)?"
  180.      (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
  181.     ("\\<\\(import\\|no\\|require\\|use\\)\\>[ \t]*\\(\\sw+\\)?"
  182.      (1 font-lock-keyword-face) (2 font-lock-reference-face nil t)))
  183.   "Subdued level highlighting for Perl mode.")
  184.  
  185. (defconst perl-font-lock-keywords-2
  186.   (append perl-font-lock-keywords-1
  187.    (list
  188.     ;;
  189.     ;; Fontify keywords, except those fontified otherwise.
  190. ;   (make-regexp '("if" "until" "while" "elsif" "else" "unless" "do" "dump"
  191. ;  "for" "foreach" "exit" "die"
  192. ;  "BEGIN" "END" "return" "exec" "eval"))
  193.     (concat "\\<\\("
  194.         "BEGIN\\|END\\|d\\(ie\\|o\\|ump\\)\\|"
  195.         "e\\(ls\\(e\\|if\\)\\|val\\|x\\(ec\\|it\\)\\)\\|"
  196.         "for\\(\\|each\\)\\|if\\|return\\|un\\(less\\|til\\)\\|while"
  197.         "\\)\\>")
  198.     ;;
  199.     ;; Fontify local and my keywords as types.
  200.     '("\\<\\(local\\|my\\)\\>" . font-lock-type-face)
  201.     ;;
  202.     ;; Fontify function, variable and file name references.
  203.     '("&\\(\\sw+\\)" 1 font-lock-function-name-face)
  204.     ;; Additionally underline non-scalar variables.  Maybe this is a bad idea.
  205.     ;;'("[$@%*][#{]?\\(\\sw+\\)" 1 font-lock-variable-name-face)
  206.     '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
  207.     '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
  208.       (2 (cons font-lock-variable-name-face '(underline))))
  209.     '("<\\(\\sw+\\)>" 1 font-lock-reference-face)
  210.     ;;
  211.     ;; Fontify keywords with/and labels as we do in `c++-font-lock-keywords'.
  212.     '("\\<\\(continue\\|goto\\|last\\|next\\|redo\\)\\>[ \t]*\\(\\sw+\\)?"
  213.       (1 font-lock-keyword-face) (2 font-lock-reference-face nil t))
  214.     '("^[ \t]*\\(\\sw+\\)[ \t]*:[^:]" 1 font-lock-reference-face)))
  215.   "Gaudy level highlighting for Perl mode.")
  216.  
  217. (defvar perl-font-lock-keywords perl-font-lock-keywords-1
  218.   "Default expressions to highlight in Perl mode.")
  219.  
  220.  
  221. (defvar perl-indent-level 4
  222.   "*Indentation of Perl statements with respect to containing block.")
  223. (defvar perl-continued-statement-offset 4
  224.   "*Extra indent for lines not starting new statements.")
  225. (defvar perl-continued-brace-offset -4
  226.   "*Extra indent for substatements that start with open-braces.
  227. This is in addition to `perl-continued-statement-offset'.")
  228. (defvar perl-brace-offset 0
  229.   "*Extra indentation for braces, compared with other text in same context.")
  230. (defvar perl-brace-imaginary-offset 0
  231.   "*Imagined indentation of an open brace that actually follows a statement.")
  232. (defvar perl-label-offset -2
  233.   "*Offset of Perl label lines relative to usual indentation.")
  234.  
  235. (defvar perl-tab-always-indent t
  236.   "*Non-nil means TAB in Perl mode always indents the current line.
  237. Otherwise it inserts a tab character if you type it past the first
  238. nonwhite character on the line.")
  239.  
  240. ;; I changed the default to nil for consistency with general Emacs
  241. ;; conventions -- rms.
  242. (defvar perl-tab-to-comment nil
  243.   "*Non-nil means TAB moves to eol or makes a comment in some cases.
  244. For lines which don't need indenting, TAB either indents an
  245. existing comment, moves to end-of-line, or if at end-of-line already,
  246. create a new comment.")
  247.  
  248. (defvar perl-nochange ";?#\\|\f\\|\\s(\\|\\(\\w\\|\\s_\\)+:"
  249.   "*Lines starting with this regular expression are not auto-indented.")
  250.  
  251. ;;;###autoload
  252. (defun perl-mode ()
  253.   "Major mode for editing Perl code.
  254. Expression and list commands understand all Perl brackets.
  255. Tab indents for Perl code.
  256. Comments are delimited with # ... \\n.
  257. Paragraphs are separated by blank lines only.
  258. Delete converts tabs to spaces as it moves back.
  259. \\{perl-mode-map}
  260. Variables controlling indentation style:
  261.  perl-tab-always-indent
  262.     Non-nil means TAB in Perl mode should always indent the current line,
  263.     regardless of where in the line point is when the TAB command is used.
  264.  perl-tab-to-comment
  265.     Non-nil means that for lines which don't need indenting, TAB will
  266.     either delete an empty comment, indent an existing comment, move 
  267.     to end-of-line, or if at end-of-line already, create a new comment.
  268.  perl-nochange
  269.     Lines starting with this regular expression are not auto-indented.
  270.  perl-indent-level
  271.     Indentation of Perl statements within surrounding block.
  272.     The surrounding block's indentation is the indentation
  273.     of the line on which the open-brace appears.
  274.  perl-continued-statement-offset
  275.     Extra indentation given to a substatement, such as the
  276.     then-clause of an if or body of a while.
  277.  perl-continued-brace-offset
  278.     Extra indentation given to a brace that starts a substatement.
  279.     This is in addition to `perl-continued-statement-offset'.
  280.  perl-brace-offset
  281.     Extra indentation for line if it starts with an open brace.
  282.  perl-brace-imaginary-offset
  283.     An open brace following other text is treated as if it were
  284.     this far to the right of the start of its line.
  285.  perl-label-offset
  286.     Extra indentation for line that is a label.
  287.  
  288. Various indentation styles:       K&R  BSD  BLK  GNU  LW
  289.   perl-indent-level                5    8    0    2    4
  290.   perl-continued-statement-offset  5    8    4    2    4
  291.   perl-continued-brace-offset      0    0    0    0   -4
  292.   perl-brace-offset               -5   -8    0    0    0
  293.   perl-brace-imaginary-offset      0    0    4    0    0
  294.   perl-label-offset               -5   -8   -2   -2   -2
  295.  
  296. Turning on Perl mode runs the normal hook `perl-mode-hook'."
  297.   (interactive)
  298.   (kill-all-local-variables)
  299.   (use-local-map perl-mode-map)
  300.   (setq major-mode 'perl-mode)
  301.   (setq mode-name "Perl")
  302.   (setq local-abbrev-table perl-mode-abbrev-table)
  303.   (set-syntax-table perl-mode-syntax-table)
  304.   (make-local-variable 'paragraph-start)
  305.   (setq paragraph-start (concat "$\\|" page-delimiter))
  306.   (make-local-variable 'paragraph-separate)
  307.   (setq paragraph-separate paragraph-start)
  308.   (make-local-variable 'paragraph-ignore-fill-prefix)
  309.   (setq paragraph-ignore-fill-prefix t)
  310.   (make-local-variable 'indent-line-function)
  311.   (setq indent-line-function 'perl-indent-line)
  312.   (make-local-variable 'require-final-newline)
  313.   (setq require-final-newline t)
  314.   (make-local-variable 'comment-start)
  315.   (setq comment-start "# ")
  316.   (make-local-variable 'comment-end)
  317.   (setq comment-end "")
  318.   (make-local-variable 'comment-column)
  319.   (setq comment-column 32)
  320.   (make-local-variable 'comment-start-skip)
  321.   (setq comment-start-skip "\\(^\\|\\s-\\);?#+ *")
  322.   (make-local-variable 'comment-indent-function)
  323.   (setq comment-indent-function 'perl-comment-indent)
  324.   (make-local-variable 'parse-sexp-ignore-comments)
  325.   (setq parse-sexp-ignore-comments t)
  326.   ;; Tell font-lock.el how to handle Perl.
  327.   (make-local-variable 'font-lock-defaults)
  328.   (setq font-lock-defaults '((perl-font-lock-keywords
  329.                   perl-font-lock-keywords-1
  330.                   perl-font-lock-keywords-2)
  331.                  nil nil ((?\_ . "w"))))
  332.   ;; Tell imenu how to handle Perl.
  333.   (make-local-variable 'imenu-generic-expression)
  334.   (setq imenu-generic-expression perl-imenu-generic-expression)
  335.   (run-hooks 'perl-mode-hook))
  336.  
  337. ;; This is used by indent-for-comment
  338. ;; to decide how much to indent a comment in Perl code
  339. ;; based on its context.
  340. (defun perl-comment-indent ()
  341.   (if (and (bolp) (not (eolp)))
  342.       0                    ;Existing comment at bol stays there.
  343.     (save-excursion
  344.       (skip-chars-backward " \t")
  345.       (max (if (bolp)            ;Else indent at comment column
  346.            0            ; except leave at least one space if
  347.          (1+ (current-column)))    ; not at beginning of line.
  348.        comment-column))))
  349.  
  350. (defun electric-perl-terminator (arg)
  351.   "Insert character and adjust indentation.
  352. If at end-of-line, and not in a comment or a quote, correct the's indentation."
  353.   (interactive "P")
  354.   (let ((insertpos (point)))
  355.     (and (not arg)            ; decide whether to indent
  356.      (eolp)
  357.      (save-excursion
  358.        (beginning-of-line)
  359.        (and (not            ; eliminate comments quickly
  360.          (re-search-forward comment-start-skip insertpos t)) 
  361.         (or (/= last-command-char ?:)
  362.             ;; Colon is special only after a label ....
  363.             (looking-at "\\s-*\\(\\w\\|\\s_\\)+$"))
  364.         (let ((pps (parse-partial-sexp 
  365.                 (perl-beginning-of-function) insertpos)))
  366.           (not (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))
  367.      (progn                ; must insert, indent, delete
  368.        (insert-char last-command-char 1)
  369.        (perl-indent-line)
  370.        (delete-char -1))))
  371.   (self-insert-command (prefix-numeric-value arg)))
  372.  
  373. ;; not used anymore, but may be useful someday:
  374. ;;(defun perl-inside-parens-p ()
  375. ;;  (condition-case ()
  376. ;;      (save-excursion
  377. ;;    (save-restriction
  378. ;;      (narrow-to-region (point)
  379. ;;                (perl-beginning-of-function))
  380. ;;      (goto-char (point-max))
  381. ;;      (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
  382. ;;    (error nil)))
  383.  
  384. (defun perl-indent-command (&optional arg)
  385.   "Indent current line as Perl code, or optionally, insert a tab character.
  386.  
  387. With an argument, indent the current line, regardless of other options.
  388.  
  389. If `perl-tab-always-indent' is nil and point is not in the indentation
  390. area at the beginning of the line, simply insert a tab.
  391.  
  392. Otherwise, indent the current line.  If point was within the indentation
  393. area it is moved to the end of the indentation area.  If the line was
  394. already indented properly and point was not within the indentation area,
  395. and if `perl-tab-to-comment' is non-nil (the default), then do the first
  396. possible action from the following list:
  397.  
  398.   1) delete an empty comment
  399.   2) move forward to start of comment, indenting if necessary
  400.   3) move forward to end of line
  401.   4) create an empty comment
  402.   5) move backward to start of comment, indenting if necessary."
  403.   (interactive "P")
  404.   (if arg                ; If arg, just indent this line
  405.       (perl-indent-line "\f")
  406.     (if (and (not perl-tab-always-indent)
  407.          (> (current-column) (current-indentation)))
  408.     (insert-tab)
  409.       (let (bof lsexp delta (oldpnt (point)))
  410.     (beginning-of-line) 
  411.     (setq lsexp (point))
  412.     (setq bof (perl-beginning-of-function))
  413.     (goto-char oldpnt)
  414.     (setq delta (perl-indent-line "\f\\|;?#" bof))
  415.     (and perl-tab-to-comment
  416.          (= oldpnt (point))        ; done if point moved
  417.          (if (listp delta)        ; if line starts in a quoted string
  418.          (setq lsexp (or (nth 2 delta) bof))
  419.            (= delta 0))        ; done if indenting occurred
  420.          (let (eol state)
  421.            (end-of-line) 
  422.            (setq eol (point))
  423.            (if (= (char-after bof) ?=)
  424.            (if (= oldpnt eol)
  425.                (message "In a format statement"))     
  426.          (setq state (parse-partial-sexp lsexp eol))
  427.          (if (nth 3 state)
  428.              (if (= oldpnt eol)    ; already at eol in a string
  429.              (message "In a string which starts with a %c."
  430.                   (nth 3 state)))
  431.            (if (not (nth 4 state))
  432.                (if (= oldpnt eol) ; no comment, create one?
  433.                (indent-for-comment))
  434.              (beginning-of-line)
  435.              (if (re-search-forward comment-start-skip eol 'move)
  436.              (if (eolp)
  437.                  (progn    ; kill existing comment
  438.                    (goto-char (match-beginning 0))
  439.                    (skip-chars-backward " \t")
  440.                    (kill-region (point) eol))
  441.                (if (or (< oldpnt (point)) (= oldpnt eol))
  442.                    (indent-for-comment) ; indent existing comment
  443.                  (end-of-line)))
  444.                (if (/= oldpnt eol)
  445.                (end-of-line)
  446.              (message "Use backslash to quote # characters.")
  447.              (ding t))))))))))))
  448.  
  449. (defun perl-indent-line (&optional nochange parse-start)
  450.   "Indent current line as Perl code.
  451. Return the amount the indentation 
  452. changed by, or (parse-state) if line starts in a quoted string."
  453.   (let ((case-fold-search nil)
  454.     (pos (- (point-max) (point)))
  455.     (bof (or parse-start (save-excursion (perl-beginning-of-function))))
  456.     beg indent shift-amt)
  457.     (beginning-of-line)
  458.     (setq beg (point))
  459.     (setq shift-amt
  460.       (cond ((= (char-after bof) ?=) 0)
  461.         ((listp (setq indent (calculate-perl-indent bof))) indent)
  462.         ((looking-at (or nochange perl-nochange)) 0)
  463.         (t
  464.          (skip-chars-forward " \t\f")
  465.          (cond ((looking-at "\\(\\w\\|\\s_\\)+:")
  466.             (setq indent (max 1 (+ indent perl-label-offset))))
  467.                ((= (following-char) ?})
  468.             (setq indent (- indent perl-indent-level)))
  469.                ((= (following-char) ?{)
  470.             (setq indent (+ indent perl-brace-offset))))
  471.          (- indent (current-column)))))
  472.     (skip-chars-forward " \t\f")
  473.     (if (and (numberp shift-amt) (/= 0 shift-amt))
  474.     (progn (delete-region beg (point))
  475.            (indent-to indent)))
  476.     ;; If initial point was within line's indentation,
  477.     ;; position after the indentation.  Else stay at same point in text.
  478.     (if (> (- (point-max) pos) (point))
  479.     (goto-char (- (point-max) pos)))
  480.     shift-amt))
  481.  
  482. (defun calculate-perl-indent (&optional parse-start)
  483.   "Return appropriate indentation for current line as Perl code.
  484. In usual case returns an integer: the column to indent to.
  485. Returns (parse-state) if line starts inside a string."
  486.   (save-excursion
  487.     (beginning-of-line)
  488.     (let ((indent-point (point))
  489.       (case-fold-search nil)
  490.       (colon-line-end 0)
  491.       state containing-sexp)
  492.       (if parse-start            ;used to avoid searching
  493.       (goto-char parse-start)
  494.     (perl-beginning-of-function))
  495.       (while (< (point) indent-point)    ;repeat until right sexp
  496.     (setq parse-start (point))
  497.     (setq state (parse-partial-sexp (point) indent-point 0))
  498. ; state = (depth_in_parens innermost_containing_list last_complete_sexp
  499. ;          string_terminator_or_nil inside_commentp following_quotep
  500. ;          minimum_paren-depth_this_scan)
  501. ; Parsing stops if depth in parentheses becomes equal to third arg.
  502.     (setq containing-sexp (nth 1 state)))
  503.       (cond ((nth 3 state) state)    ; In a quoted string?
  504.         ((null containing-sexp)    ; Line is at top level.
  505.          (skip-chars-forward " \t\f")
  506.          (if (= (following-char) ?{)
  507.          0   ; move to beginning of line if it starts a function body
  508.            ;; indent a little if this is a continuation line
  509.            (perl-backward-to-noncomment)
  510.            (if (or (bobp)
  511.                (memq (preceding-char) '(?\; ?\})))
  512.            0 perl-continued-statement-offset)))
  513.         ((/= (char-after containing-sexp) ?{)
  514.          ;; line is expression, not statement:
  515.          ;; indent to just after the surrounding open.
  516.          (goto-char (1+ containing-sexp))
  517.          (current-column))
  518.         (t
  519.          ;; Statement level.  Is it a continuation or a new statement?
  520.          ;; Find previous non-comment character.
  521.          (perl-backward-to-noncomment)
  522.          ;; Back up over label lines, since they don't
  523.          ;; affect whether our line is a continuation.
  524.          (while (or (eq (preceding-char) ?\,)
  525.             (and (eq (preceding-char) ?:)
  526.                  (memq (char-syntax (char-after (- (point) 2)))
  527.                    '(?w ?_))))
  528.            (if (eq (preceding-char) ?\,)
  529.            (perl-backward-to-start-of-continued-exp containing-sexp)
  530.          (beginning-of-line))
  531.            (perl-backward-to-noncomment))
  532.          ;; Now we get the answer.
  533.          (if (not (memq (preceding-char) '(?\; ?\} ?\{)))
  534.          ;; This line is continuation of preceding line's statement;
  535.          ;; indent  perl-continued-statement-offset  more than the
  536.          ;; previous line of the statement.
  537.          (progn
  538.            (perl-backward-to-start-of-continued-exp containing-sexp)
  539.            (+ perl-continued-statement-offset (current-column)
  540.               (if (save-excursion (goto-char indent-point)
  541.                       (looking-at "[ \t]*{"))
  542.               perl-continued-brace-offset 0)))
  543.            ;; This line starts a new statement.
  544.            ;; Position at last unclosed open.
  545.            (goto-char containing-sexp)
  546.            (or
  547.          ;; If open paren is in col 0, close brace is special
  548.          (and (bolp)
  549.               (save-excursion (goto-char indent-point)
  550.                       (looking-at "[ \t]*}"))
  551.               perl-indent-level)
  552.          ;; Is line first statement after an open-brace?
  553.          ;; If no, find that first statement and indent like it.
  554.          (save-excursion
  555.            (forward-char 1)
  556.            ;; Skip over comments and labels following openbrace.
  557.            (while (progn
  558.                 (skip-chars-forward " \t\f\n")
  559.                 (cond ((looking-at ";?#")
  560.                    (forward-line 1) t)
  561.                   ((looking-at "\\(\\w\\|\\s_\\)+:")
  562.                    (save-excursion 
  563.                      (end-of-line) 
  564.                      (setq colon-line-end (point)))
  565.                    (search-forward ":")))))
  566.            ;; The first following code counts
  567.            ;; if it is before the line we want to indent.
  568.            (and (< (point) indent-point)
  569.             (if (> colon-line-end (point))
  570.                 (- (current-indentation) perl-label-offset)
  571.               (current-column))))
  572.          ;; If no previous statement,
  573.          ;; indent it relative to line brace is on.
  574.          ;; For open paren in column zero, don't let statement
  575.          ;; start there too.  If perl-indent-level is zero,
  576.          ;; use perl-brace-offset + perl-continued-statement-offset
  577.          ;; For open-braces not the first thing in a line,
  578.          ;; add in perl-brace-imaginary-offset.
  579.          (+ (if (and (bolp) (zerop perl-indent-level))
  580.             (+ perl-brace-offset perl-continued-statement-offset)
  581.               perl-indent-level)
  582.             ;; Move back over whitespace before the openbrace.
  583.             ;; If openbrace is not first nonwhite thing on the line,
  584.             ;; add the perl-brace-imaginary-offset.
  585.             (progn (skip-chars-backward " \t")
  586.                (if (bolp) 0 perl-brace-imaginary-offset))
  587.             ;; If the openbrace is preceded by a parenthesized exp,
  588.             ;; move to the beginning of that;
  589.             ;; possibly a different line
  590.             (progn
  591.               (if (eq (preceding-char) ?\))
  592.               (forward-sexp -1))
  593.               ;; Get initial indentation of the line we are on.
  594.               (current-indentation))))))))))
  595.  
  596. (defun perl-backward-to-noncomment ()
  597.   "Move point backward to after the first non-white-space, skipping comments."
  598.   (interactive)
  599.   (let (opoint stop)
  600.     (while (not stop)
  601.       (setq opoint (point))
  602.       (beginning-of-line)
  603.       (if (re-search-forward comment-start-skip opoint 'move 1)
  604.       (progn (goto-char (match-end 1))
  605.          (skip-chars-forward ";")))
  606.       (skip-chars-backward " \t\f")
  607.       (setq stop (or (bobp)
  608.              (not (bolp))
  609.              (forward-char -1))))))
  610.  
  611. (defun perl-backward-to-start-of-continued-exp (lim)
  612.   (if (= (preceding-char) ?\))
  613.       (forward-sexp -1))
  614.   (beginning-of-line)
  615.   (if (<= (point) lim)
  616.       (goto-char (1+ lim)))
  617.   (skip-chars-forward " \t\f"))
  618.  
  619. ;; note: this may be slower than the c-mode version, but I can understand it.
  620. (defun indent-perl-exp ()
  621.   "Indent each line of the Perl grouping following point."
  622.   (interactive)
  623.   (let* ((case-fold-search nil)
  624.      (oldpnt (point-marker))
  625.      (bof-mark (save-excursion
  626.              (end-of-line 2)
  627.              (perl-beginning-of-function)
  628.              (point-marker)))
  629.      eol last-mark lsexp-mark delta)
  630.     (if (= (char-after (marker-position bof-mark)) ?=)
  631.     (message "Can't indent a format statement")
  632.       (message "Indenting Perl expression...")
  633.       (save-excursion (end-of-line) (setq eol (point)))
  634.       (save-excursion            ; locate matching close paren
  635.     (while (and (not (eobp)) (<= (point) eol))
  636.       (parse-partial-sexp (point) (point-max) 0))
  637.     (setq last-mark (point-marker)))
  638.       (setq lsexp-mark bof-mark)
  639.       (beginning-of-line)
  640.       (while (< (point) (marker-position last-mark))
  641.     (setq delta (perl-indent-line nil (marker-position bof-mark)))
  642.     (if (numberp delta)        ; unquoted start-of-line?
  643.         (progn 
  644.           (if (eolp)
  645.           (delete-horizontal-space))
  646.           (setq lsexp-mark (point-marker))))
  647.     (end-of-line)
  648.     (setq eol (point))
  649.     (if (nth 4 (parse-partial-sexp (marker-position lsexp-mark) eol))
  650.         (progn            ; line ends in a comment
  651.           (beginning-of-line)
  652.           (if (or (not (looking-at "\\s-*;?#"))
  653.               (listp delta)
  654.               (and (/= 0 delta)
  655.                (= (- (current-indentation) delta) comment-column)))
  656.           (if (re-search-forward comment-start-skip eol t)
  657.               (indent-for-comment))))) ; indent existing comment
  658.     (forward-line 1))
  659.       (goto-char (marker-position oldpnt))
  660.       (message "Indenting Perl expression...done"))))
  661.  
  662. (defun perl-beginning-of-function (&optional arg)
  663.   "Move backward to next beginning-of-function, or as far as possible.
  664. With argument, repeat that many times; negative args move forward.
  665. Returns new value of point in all cases."
  666.   (interactive "p")
  667.   (or arg (setq arg 1))
  668.   (if (< arg 0) (forward-char 1))
  669.   (and (/= arg 0)
  670.        (re-search-backward "^\\s(\\|^\\s-*sub\\b[^{]+{\\|^\\s-*format\\b[^=]*=\\|^\\."
  671.                nil 'move arg)
  672.        (goto-char (1- (match-end 0))))
  673.   (point))
  674.  
  675. ;; note: this routine is adapted directly from emacs lisp.el, end-of-defun;
  676. ;; no bugs have been removed :-)
  677. (defun perl-end-of-function (&optional arg)
  678.   "Move forward to next end-of-function.
  679. The end of a function is found by moving forward from the beginning of one.
  680. With argument, repeat that many times; negative args move backward."
  681.   (interactive "p")
  682.   (or arg (setq arg 1))
  683.   (let ((first t))
  684.     (while (and (> arg 0) (< (point) (point-max)))
  685.       (let ((pos (point)) npos)
  686.     (while (progn
  687.         (if (and first
  688.              (progn
  689.               (forward-char 1)
  690.               (perl-beginning-of-function 1)
  691.               (not (bobp))))
  692.             nil
  693.           (or (bobp) (forward-char -1))
  694.           (perl-beginning-of-function -1))
  695.         (setq first nil)
  696.         (forward-list 1)
  697.         (skip-chars-forward " \t")
  698.         (if (looking-at "[#\n]")
  699.             (forward-line 1))
  700.         (<= (point) pos))))
  701.       (setq arg (1- arg)))
  702.     (while (< arg 0)
  703.       (let ((pos (point)))
  704.     (perl-beginning-of-function 1)
  705.     (forward-sexp 1)
  706.     (forward-line 1)
  707.     (if (>= (point) pos)
  708.         (if (progn (perl-beginning-of-function 2) (not (bobp)))
  709.         (progn
  710.           (forward-list 1)
  711.           (skip-chars-forward " \t")
  712.           (if (looking-at "[#\n]")
  713.               (forward-line 1)))
  714.           (goto-char (point-min)))))
  715.       (setq arg (1+ arg)))))
  716.  
  717. (defun mark-perl-function ()
  718.   "Put mark at end of Perl function, point at beginning."
  719.   (interactive)
  720.   (push-mark (point))
  721.   (perl-end-of-function)
  722.   (push-mark (point))
  723.   (perl-beginning-of-function)
  724.   (backward-paragraph))
  725.  
  726. ;;;;;;;; That's all, folks! ;;;;;;;;;
  727.